Skip to content

fix: Crashed on startup if djangocms-text was not installed #266

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 6 commits into from
Mar 27, 2025
Merged

fix: Crashed on startup if djangocms-text was not installed #266

merged 6 commits into from
Mar 27, 2025

Conversation

@fsbraun
Copy link
Member

@fsbraun fsbraun commented Mar 27, 2025 •
edited by sourcery-ai bot
Loading

Summary by Sourcery

Fix startup crash when djangocms-text is not installed by improving component discovery and field configuration

Bug Fixes:

  • Prevent application from crashing on startup when djangocms-text package is not installed
  • Correct field type references for text-related form fields

Enhancements:

  • Improve robustness of component discovery mechanism by checking package installation before accessing configuration

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Mar 27, 2025 •
edited
Loading

Reviewer's Guide by Sourcery

This pull request fixes a crash on startup that occurred when djangocms-text was not installed. It also corrects the form field lookup for djangocms-text to use HTMLFormField instead of TextFormField.

Updated class diagram for CMSAutoComponentDiscovery

classDiagram
  class CMSAutoComponentDiscovery {
    default_field_context
  }
  note for CMSAutoComponentDiscovery.default_field_context "djangocms_text field updated to HTMLFormField"
Loading

File-Level Changes

Change Details Files
Corrected the form field lookup for djangocms-text to use HTMLFormField instead of TextFormField.
  • Updated default_field_context in CMSAutoComponentDiscovery to use HTMLFormField for djangocms_text.
 djangocms_frontend/component_pool.py
Ensured that the djangocms_text app is installed before attempting to access its configuration.
  • Used apps.is_installed("djangocms_text") to check if the app is installed before accessing its configuration.
  • Moved the text_config = apps.get_app_config("djangocms_text") assignment inside the if block.
 djangocms_frontend/component_pool.py
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot reviewed Mar 27, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @fsbraun - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider extracting the apps.is_installed check into a separate function for better readability.
  • It might be worth adding a comment explaining why the inline models need to be updated when djangocms_text is installed before djangocms_frontend.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good
Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@codecov
Copy link

codecov bot commented Mar 27, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 50.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 88.69%. Comparing base (af923bf) to head (2104fc2).
Report is 21 commits behind head on master.

Files with missing lines Patch % Lines
djangocms_frontend/component_pool.py 50.00% 0 Missing and 1 partial ⚠️
Additional details and impacted files 
@@           Coverage Diff           @@
##           master     #266   +/-   ##
=======================================
  Coverage   88.69%   88.69%           
=======================================
  Files         124      124           
  Lines        3360     3361    +1     
  Branches      283      283           
=======================================
+ Hits         2980     2981    +1     
  Misses        263      263           
  Partials      117      117

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@fsbraun fsbraun merged commit c80cf19 into master Mar 27, 2025
21 of 22 checks passed
@fsbraun fsbraun deleted the chore/release-2-1 branch March 27, 2025 14:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@fsbraun